doxygen-choke
authorSamuel Thibault <sthibault@debian.org>
Thu, 4 Dec 2025 16:54:23 +0000 (17:54 +0100)
committerSamuel Thibault <sthibault@debian.org>
Thu, 4 Dec 2025 16:54:23 +0000 (17:54 +0100)
commit 1d641863e604a7ced708e63c6a8dbd3e2f6bb781
Author: Samuel Thibault <samuel.thibault@ens-lyon.org>
Date:   Thu Dec 4 00:18:02 2025 +0100

    Fix typos making doxygen 1.15.0 choke

Gbp-Pq: Name doxygen-choke

18 files changed:
doc/doxygen.cfg
doc/doxygen/chapters/api/threads.doxy
doc/doxygen/chapters/fdl_1_3.doxy
doc/doxygen/chapters/starpu_basics/data_management.doxy
doc/doxygen/chapters/starpu_extensions/advanced_data_management.doxy
doc/doxygen/chapters/starpu_extensions/bubble.doxy
doc/doxygen/chapters/starpu_extensions/debugging_tools.doxy
doc/doxygen/chapters/starpu_extensions/max_fpga_support.doxy
doc/doxygen/chapters/starpu_extensions/out_of_core.doxy
doc/doxygen/chapters/starpu_extensions/scheduling_context_hypervisor.doxy
doc/doxygen/chapters/starpu_extensions/transactions.doxy
doc/doxygen/chapters/starpu_installation/environment_variables.doxy
doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy
include/starpu_openmp.h
include/starpu_perf_steering.h
include/starpu_sched_component.h
mpi/include/starpu_mpi.h
mpi/include/starpu_mpi_ft.h

index 5edefcc5aeb11b80e9b377a6031fb32898ed7331..da7fcee3f325e0aa1a56d81f89bc86c4ada6afc4 100644 (file)
@@ -644,7 +644,7 @@ QUIET                  = YES
 # generated by doxygen. Possible values are YES and NO. If left blank
 # NO is used.
 
-WARNINGS               = NO
+WARNINGS               = YES
 
 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
index 9d9b2b9899420dda656ad5f0884b10fc868f191b..fab2b489827c030168e52a1ba4de77eaea17a27f 100644 (file)
@@ -219,7 +219,7 @@ This function also produces trace when the configure option
 Behave identically to starpu_pthread_mutex_lock(),
 except that it does not block the calling thread if the mutex is
 already locked by another thread (or by the calling thread in the case
-of a ``fast''  mutex). Instead, the function returns immediately with
+of a ``fast``  mutex). Instead, the function returns immediately with
 the error code \c EBUSY.
 
 This function also produces trace when the configure option
index d66e844283edba02b50b170608ca126ac3145dc6..a75c21b21de0ae1638f00747f0998d28c7f1a50e 100644 (file)
@@ -40,7 +40,7 @@ Secondarily, this License preserves for the author and publisher a way
 to get credit for their work, while not being considered responsible
 for modifications made by others.
 
-This License is a kind of ``copyleft'', which means that derivative
+This License is a kind of ``copyleft``, which means that derivative
 works of the document must themselves be free in the same sense.  It
 complements the GNU General Public License, which is a copyleft
 license designed for free software.
@@ -61,17 +61,17 @@ This License applies to any manual or other work, in any medium, that
 contains a notice placed by the copyright holder saying it can be
 distributed under the terms of this License.  Such a notice grants a
 world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein.  The ``Document'', below,
+work under the conditions stated herein.  The ``Document``, below,
 refers to any such manual or work.  Any member of the public is a
-licensee, and is addressed as ``you''.  You accept the license if you
+licensee, and is addressed as ``you``.  You accept the license if you
 copy, modify or distribute the work in a way requiring permission
 under copyright law.
 
-A ``Modified Version'' of the Document means any work containing the
+A ``Modified Version`` of the Document means any work containing the
 Document or a portion of it, either copied verbatim, or with
 modifications and/or translated into another language.
 
-A ``Secondary Section'' is a named appendix or a front-matter section
+A ``Secondary Section`` is a named appendix or a front-matter section
 of the Document that deals exclusively with the relationship of the
 publishers or authors of the Document to the Document's overall
 subject (or to related matters) and contains nothing that could fall
@@ -82,7 +82,7 @@ connection with the subject or with related matters, or of legal,
 commercial, philosophical, ethical or political position regarding
 them.
 
-The ``Invariant Sections'' are certain Secondary Sections whose titles
+The ``Invariant Sections`` are certain Secondary Sections whose titles
 are designated, as being those of Invariant Sections, in the notice
 that says that the Document is released under this License.  If a
 section does not fit the above definition of Secondary then it is not
@@ -90,12 +90,12 @@ allowed to be designated as Invariant.  The Document may contain zero
 Invariant Sections.  If the Document does not identify any Invariant
 Sections then there are none.
 
-The ``Cover Texts'' are certain short passages of text that are listed,
+The ``Cover Texts`` are certain short passages of text that are listed,
 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
 the Document is released under this License.  A Front-Cover Text may
 be at most 5 words, and a Back-Cover Text may be at most 25 words.
 
-A ``Transparent'' copy of the Document means a machine-readable copy,
+A ``Transparent`` copy of the Document means a machine-readable copy,
 represented in a format whose specification is available to the
 general public, that is suitable for revising the document
 straightforwardly with generic text editors or (for images composed of
@@ -106,7 +106,7 @@ to text formatters.  A copy made in an otherwise Transparent file
 format whose markup, or absence of markup, has been arranged to thwart
 or discourage subsequent modification by readers is not Transparent.
 An image format is not Transparent if used for any substantial amount
-of text.  A copy that is not ``Transparent'' is called ``Opaque''.
+of text.  A copy that is not ``Transparent`` is called ``Opaque``.
 
 Examples of suitable formats for Transparent copies include plain
 ASCII without markup, Texinfo input format, LaTeX input
@@ -121,23 +121,23 @@ not generally available, and the machine-generated HTML,
 PostScript or PDF produced by some word processors for
 output purposes only.
 
-The ``Title Page'' means, for a printed book, the title page itself,
+The ``Title Page`` means, for a printed book, the title page itself,
 plus such following pages as are needed to hold, legibly, the material
 this License requires to appear in the title page.  For works in
-formats which do not have any title page as such, ``Title Page'' means
+formats which do not have any title page as such, ``Title Page`` means
 the text near the most prominent appearance of the work's title,
 preceding the beginning of the body of the text.
 
-The ``publisher'' means any person or entity that distributes copies
+The ``publisher`` means any person or entity that distributes copies
 of the Document to the public.
 
-A section ``Entitled XYZ'' means a named subunit of the Document whose
+A section ``Entitled XYZ`` means a named subunit of the Document whose
 title either is precisely XYZ or contains XYZ in parentheses following
 text that translates XYZ in another language.  (Here XYZ stands for a
-specific section name mentioned below, such as ``Acknowledgements'',
-``Dedications'', ``Endorsements'', or ``History''.)  To ``Preserve the Title''
+specific section name mentioned below, such as ``Acknowledgements``,
+``Dedications``, ``Endorsements``, or ``History``.)  To ``Preserve the Title``
 of such a section when you modify the Document means that it remains a
-section ``Entitled XYZ'' according to this definition.
+section ``Entitled XYZ`` according to this definition.
 
 The Document may include Warranty Disclaimers next to the notice which
 states that this License applies to the Document.  These Warranty
@@ -252,10 +252,10 @@ and required Cover Texts given in the Document's license notice.
 Include an unaltered copy of this License.
 </li>
 <li>
-Preserve the section Entitled ``History'', Preserve its Title, and add
+Preserve the section Entitled ``History``, Preserve its Title, and add
 to it an item stating at least the title, year, new authors, and
 publisher of the Modified Version as given on the Title Page.  If
-there is no section Entitled ``History'' in the Document, create one
+there is no section Entitled ``History`` in the Document, create one
 stating the title, year, authors, and publisher of the Document as
 given on its Title Page, then add an item describing the Modified
 Version as stated in the previous sentence.
@@ -264,13 +264,13 @@ Version as stated in the previous sentence.
 Preserve the network location, if any, given in the Document for
 public access to a Transparent copy of the Document, and likewise
 the network locations given in the Document for previous versions
-it was based on.  These may be placed in the ``History'' section.
+it was based on.  These may be placed in the ``History`` section.
 You may omit a network location for a work that was published at
 least four years before the Document itself, or if the original
 publisher of the version it refers to gives permission.
 </li>
 <li>
-For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
+For any section Entitled ``Acknowledgements`` or ``Dedications``, Preserve
 the Title of the section, and preserve in the section all the
 substance and tone of each of the contributor acknowledgements and/or
 dedications given therein.
@@ -281,11 +281,11 @@ unaltered in their text and in their titles.  Section numbers
 or the equivalent are not considered part of the section titles.
 </li>
 <li>
-Delete any section Entitled ``Endorsements''.  Such a section
+Delete any section Entitled ``Endorsements``.  Such a section
 may not be included in the Modified Version.
 </li>
 <li>
-Do not retitle any existing section to be Entitled ``Endorsements'' or
+Do not retitle any existing section to be Entitled ``Endorsements`` or
 to conflict in title with any Invariant Section.
 </li>
 <li>
@@ -300,7 +300,7 @@ of these sections as invariant.  To do this, add their titles to the
 list of Invariant Sections in the Modified Version's license notice.
 These titles must be distinct from any other section titles.
 
-You may add a section Entitled ``Endorsements'', provided it contains
+You may add a section Entitled ``Endorsements``, provided it contains
 nothing but endorsements of your Modified Version by various
 parties---for example, statements of peer review or that the text has
 been approved by an organization as the authoritative definition of a
@@ -340,11 +340,11 @@ author or publisher of that section if known, or else a unique number.
 Make the same adjustment to the section titles in the list of
 Invariant Sections in the license notice of the combined work.
 
-In the combination, you must combine any sections Entitled ``History''
+In the combination, you must combine any sections Entitled ``History``
 in the various original documents, forming one section Entitled
-``History''; likewise combine any sections Entitled ``Acknowledgements'',
-and any sections Entitled ``Dedications''.  You must delete all
-sections Entitled ``Endorsements.''
+``History``; likewise combine any sections Entitled ``Acknowledgements``,
+and any sections Entitled ``Dedications``.  You must delete all
+sections Entitled ``Endorsements.``
 </li>
 
 <li>
@@ -367,7 +367,7 @@ AGGREGATION WITH INDEPENDENT WORKS
 
 A compilation of the Document or its derivatives with other separate
 and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an ``aggregate'' if the copyright
+distribution medium, is called an ``aggregate`` if the copyright
 resulting from the compilation is not used to limit the legal rights
 of the compilation's users beyond what the individual works permit.
 When the Document is included in an aggregate, this License does not
@@ -399,8 +399,8 @@ of those notices and disclaimers.  In case of a disagreement between
 the translation and the original version of this License or a notice
 or disclaimer, the original version will prevail.
 
-If a section in the Document is Entitled ``Acknowledgements'',
-``Dedications'', or ``History'', the requirement (section 4) to Preserve
+If a section in the Document is Entitled ``Acknowledgements``,
+``Dedications``, or ``History``, the requirement (section 4) to Preserve
 its Title (section 1) will typically require changing the actual
 title.
 </li>
@@ -445,7 +445,7 @@ http://www.gnu.org/copyleft/.
 
 Each version of the License is given a distinguishing version number.
 If the Document specifies that a particular numbered version of this
-License ``or any later version'' applies to it, you have the option of
+License ``or any later version`` applies to it, you have the option of
 following the terms and conditions either of that specified version or
 of any later version that has been published (not as a draft) by the
 Free Software Foundation.  If the Document does not specify a version
@@ -460,24 +460,24 @@ Document.
 <li>
 RELICENSING
 
-``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
+``Massive Multiauthor Collaboration Site`` (or ``MMC Site``) means any
 World Wide Web server that publishes copyrightable works and also
 provides prominent facilities for anybody to edit those works.  A
 public wiki that anybody can edit is an example of such a server.  A
-``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
+``Massive Multiauthor Collaboration`` (or ``MMC``) contained in the
 site means any set of copyrightable works thus published on the MMC
 site.
 
-``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
+``CC-BY-SA`` means the Creative Commons Attribution-Share Alike 3.0
 license published by Creative Commons Corporation, a not-for-profit
 corporation with a principal place of business in San Francisco,
 California, as well as future copyleft versions of that license
 published by that same organization.
 
-``Incorporate'' means to publish or republish a Document, in whole or
+``Incorporate`` means to publish or republish a Document, in whole or
 in part, as part of another Document.
 
-An MMC is ``eligible for relicensing'' if it is licensed under this
+An MMC is ``eligible for relicensing`` if it is licensed under this
 License, and if all works that were first published under this License
 somewhere other than this MMC, and subsequently incorporated in whole
 or in part into the MMC, (1) had no cover texts or invariant sections,
@@ -502,11 +502,11 @@ license notices just after the title page:
   or any later version published by the Free Software Foundation;
   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
   Texts.  A copy of the license is included in the section entitled ``GNU
-  Free Documentation License''.
+  Free Documentation License``.
 </blockquote>
 
 If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the ``with...Texts.'' line with this:
+replace the ``with...Texts.`` line with this:
 
 <blockquote>
     with the Invariant Sections being <em>list their titles</em>, with
index fdbeb8568270be2b051bf26d64976af85ec37eb0..44d2d6f994db9abf4000de63600a696be6b2b10f 100644 (file)
@@ -290,8 +290,8 @@ uint32_t colind[NNZ_BLOCKS] =
 };
 uint32_t rowptr[NROWS+1] =
 {
-       0, / * block-index in nzval of the first block of the first row. */
-       1, / * block-index in nzval of the first block of the second row. */
+       0, /* block-index in nzval of the first block of the first row. */
+       1, /* block-index in nzval of the first block of the second row. */
        NNZ_BLOCKS /* number of blocks, to allow an easier element's access for the kernels */
 };
 
index 354ef0776d37e87eb9caea4c88cd5fc4f507aa30..5b896aa6c8c3aa459124007d30aa80f801ddd0af 100644 (file)
@@ -360,7 +360,7 @@ can compare <c>examples/interface/complex_interface.c</c> vs
 StarPU provides a series of predefined filters in \ref API_Data_Partition, but
 additional filters can be defined by the application. The principle is that the
 filter function just fills the memory location of the <c>i-th</c> subpart of a data.
-Examples are provided in <c>src/datawizard/interfaces/*_filters.c</c>,
+Examples are provided in <c>src/datawizard/interfaces/\*_filters.c</c>,
 check \ref starpu_data_filter::filter_func for further details.
 The helper function starpu_filter_nparts_compute_chunk_size_and_offset() can be used to
 compute the division of pieces of data.
@@ -723,7 +723,7 @@ In the example described above, the two pointers stored in the data interface
 are data buffers, which may point into main memory, GPU memory, etc. One may also
 want to store pointers to meta-data for the interface, for instance the list of
 dimensions sizes for the n-dimension matrix interface, but such pointers are to
-be handled completely differently. More examples are provided in <c>src/datawizard/interfaces/*_interface.c</c>
+be handled completely differently. More examples are provided in <c>src/datawizard/interfaces/\*_interface.c</c>
 
 More precisely, there are two types of pointers:
 
index 54cd67d41c78f57ca671763b2dec6e9fd94209b6..62a8c0b446e35acbb6217ace7c5b667a47caf437 100644 (file)
@@ -191,6 +191,6 @@ When executed, the function starpu_codelet::bubble_gen_dag_func will be
 given as parameter the task being turned into a hierarchical task and
 the value specified with ::STARPU_BUBBLE_GEN_DAG_FUNC_ARG.
 
-An example involving these functions is in <c>bubble/tests/basic/brec.c</c>. And more examples are available in <c>bubble/tests/basic/*.c</c>.
+An example involving these functions is in <c>bubble/tests/basic/brec.c</c>. And more examples are available in <c>bubble/tests/basic/\*.c</c>.
 
 */
index 06f4d3b400e36503b90c5bee57836c811861e337..de4558ef3f41594e173f7376cb88905914063766 100644 (file)
@@ -30,7 +30,7 @@ catchup assertions. If your program is valgrind-safe, you can use it, see \ref
 UsingOtherDebugger.
 
 Depending on your toolchain, it might happen that you get
-<c>undefined reference to `__stack_chk_guard'</c> errors. In that case, use the
+<c>undefined reference to `__stack_chk_guard`</c> errors. In that case, use the
 <c>--disable-fstack-protector-all</c> option to avoid the issue.
 
 Then, if your program crashes with an assertion error, a segfault, etc. you can send us the result of
@@ -89,7 +89,7 @@ was passed to <c>configure</c>
 Valgrind can be used on StarPU: valgrind.h just needs to be found at <c>configure</c>
 time, to tell valgrind about some known false positives and disable host memory
 pinning. Other known false positives can be suppressed by giving the suppression
-files in <c>tools/valgrind/*.suppr</c> to valgrind's <c>--suppressions</c> option.
+files in <c>tools/valgrind/\*.suppr</c> to valgrind's <c>--suppressions</c> option.
 
 The environment variable \ref STARPU_DISABLE_KERNELS can also be set to <c>1</c> to make
 StarPU does everything (schedule tasks, transfer memory, etc.) except actually
index b0f4113e35da78e71e4fa0908a1e9515e5b0f828..c5f1624050a6805c202edac4240376c1360a5a30 100644 (file)
@@ -274,7 +274,7 @@ The design load can also be delegated to StarPU by specifying an array
 of load specifications in <c>starpu_conf::max_fpga_load</c>, and use
 starpu_max_fpga_get_local_engine() to access the loaded max engines.
 
-Complete examples are available in <c>tests/fpga/*.c</c>
+Complete examples are available in <c>tests/fpga/\*.c</c>
 
 \subsection MaxFPGADataTransfers Data Transfers in StarPU/Maxeler FPGA Applications
 
index c7463283e9a6b2724a3dcbf1169c372ec294657f..017f44e33ade7541a7dae7ee3cb0e407ba1a938e 100644 (file)
@@ -50,7 +50,7 @@ machine memory size, but part of it is taken by the kernel, the system,
 daemons, and the application's own allocated data, whose size can not be
 predicted. That is why users need to specify what StarPU can afford.
 
-Some Out-of-core tests are worth giving a read, see <c>tests/disk/*.c</c>
+Some Out-of-core tests are worth giving a read, see <c>tests/disk/\*.c</c>
 
 \section UseANewDiskMemory Use a new disk memory
 
index 42c715cdefd8da1da5ad0517b3140d783521c7a2..30c44eaa7a298ca46f721e72f22c90fa93d9f351 100644 (file)
@@ -37,7 +37,7 @@ decides accordingly when and how the contexts can be resized. Basic
 strategies of resizing scheduling contexts already exist, but a
 platform for implementing additional custom ones is available.
 
-Several examples of hypervisor are provided in <c>sc_hypervisor/examples/*.c</c>
+Several examples of hypervisor are provided in <c>sc_hypervisor/examples/\*.c</c>
 
 \section StartTheHypervisor Start the Hypervisor
 
@@ -230,6 +230,6 @@ struct sc_hypervisor_policy dummy_policy =
 };
 \endcode
 
-Examples are provided in <c>sc_hypervisor/src/hypervisor_policies/*_policy.c</c>
+Examples are provided in <c>sc_hypervisor/src/hypervisor_policies/\*_policy.c</c>
 
 */
index e9cac8b90c19796d09712b340e777eb49ec46aa9..3a636817bee01d8bbab958264e892fcef7a7dd7e 100644 (file)
@@ -60,7 +60,7 @@ will return \c NULL.
 \subsection TransactionsTasks Transaction Tasks
 Tasks governed by the same transaction object should be passed that transaction object either through
 the \c .transaction field of \ref starpu_task structures, using the \ref STARPU_TRANSACTION argument
-of \ref starpu_task_insert().
+of starpu_task_insert().
 
 \subsection TransactionsEpochNext Epoch Transition
 The transition from one transaction epoch to the next is expressed using the
index 556620de992ef1b91a71774fc590c9fc5a9c8892..8728d20bcee38b7c9a1ba32193c7d400a261362c 100644 (file)
@@ -1222,13 +1222,6 @@ When unset or set to 0, the platform file created for SimGrid will
 contain PCI bandwidths and routes.
 </dd>
 
-<dt>STARPU_SIMGRID_CUDA_QUEUE_COST</dt>
-<dd>
-\anchor STARPU_SIMGRID_CUDA_QUEUE_COST
-\addindex __env__STARPU_SIMGRID_CUDA_QUEUE_COST
-When unset or set to 1, simulate within SimGrid the GPU transfer queueing.
-</dd>
-
 <dt>STARPU_MALLOC_SIMULATION_FOLD</dt>
 <dd>
 \anchor STARPU_MALLOC_SIMULATION_FOLD
index 609025f81948c79d27be6a7ddf441d074256e93d..39fd564774dcd352047a710782e0d4c46bbbb6a7 100644 (file)
@@ -127,7 +127,7 @@ submitted).
 \subsection StarPUDataManagementLibrary StarPU Data Management Library
 
 As StarPU dynamically schedules tasks at runtime, the need for data
-transfers is automatically managed in a``just-in-time'' manner between
+transfers is automatically managed in a``just-in-time`` manner between
 different processing units,
 This automated approach alleviates the burden on application
 programmers to explicitly handle data transfers.
index 71c5edb7cc31835ff1abe5188598a939cc9499a9..0649b74825d48c97ca6d6d245d7ba33aa0d4e5b9 100644 (file)
@@ -56,7 +56,7 @@ typedef struct
 
 /**
    Set of constants for selecting the for loop iteration scheduling
-   algorithm (\anchor OMPFor) as defined by the OpenMP specification.
+   algorithm (see \ref OMPFor) as defined by the OpenMP specification.
    \sa starpu_omp_for()
    \sa starpu_omp_for_inline_first()
    \sa starpu_omp_for_inline_next()
index 0a3215e5443c2429d0e6a0da7edcbc75e1053da9..b9d96746714a82536e0548a395e7cdbd989b9c41 100644 (file)
@@ -31,7 +31,7 @@ extern "C" {
 
 /**
    @name API
-   \anchor PM_API
+   \anchor PS_API
    @{
 */
 
index e3573b45c3ac68bed451d5fc6ce89f2f67f562ae..2130d8ee8223cfffe79ce80f30cae7413f6e2050 100644 (file)
@@ -742,6 +742,8 @@ struct starpu_sched_component_specs
 struct starpu_sched_tree *starpu_sched_component_make_scheduler(unsigned sched_ctx_id, struct starpu_sched_component_specs s);
 #endif /* STARPU_HAVE_HWLOC */
 
+/** @} */
+
 /**
    @name Basic API
    @{
index 386135bc3bc9f9c630b89ea564adee51d633d1fa..8d0f34cad2cd91525b328979f740094878f846ed 100644 (file)
@@ -1018,6 +1018,8 @@ void starpu_mpi_tags_free(int64_t mintag);
 
 /** @} */
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif
index 4d8e43ac7bfead456611953f088ef211c91ddaeb..268b286c6b702d4894eb08c7047b764ce511affc 100644 (file)
@@ -123,10 +123,10 @@ static inline int starpu_mpi_checkpoint_template_print(starpu_mpi_checkpoint_tem
 static inline int starpu_mpi_checkpoint_init(void) { return 0; }
 static inline int starpu_mpi_checkpoint_shutdown(void) { return 0; }
 
-/** @} */
-
 #endif // STARPU_USE_MPI_FT
 
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif